home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / bbs / ny_010w1.zip / 3RDPARTY.DOC next >
Text File  |  1996-03-24  |  14KB  |  298 lines
  1. ==============================================================================
  2. NY2008 Third Party Development Manual (update 10)
  3. ==============================================================================
  4.  
  5. > NEW STUFF THAT WAS ADDED IN UPDATE 6!
  6. | NEW STUFF THAT WAS ADDED IN UPDATE 7!
  7. * NEW STUFF THAT WAS ADDED IN UPDATE 8!
  8. @ NEW STUFF THAT WAS ADDED IN UPDATE 9!
  9. } NEW STUFF THAT WAS ADDED IN UPDATE 10!
  10.  
  11. } I found a misspelling, CRAPS is supposed to be CRABS ... oh well ... not to
  12. } make any incompatibilities, all the data files still use CRAPS ... but
  13. } please make your igm display CRABS ... sorry bout this:)
  14.  
  15. > From wide beta 7 up the .inf drop file has changed format a bit, READ ON
  16. > if you made any IGM's for wide beta 6 or lower!
  17.  
  18. @ You can now add IGMs to be fight events. You just create a file called
  19. @ 3rdevent.dat with same format as 3rdparty.dat. If this file exists NY2008
  20. @ will sometimes ask the player instead of a fight event if he wants to enter 
  21. @ a randomly chozen IGM for the 3rdevent.dat file.
  22.  
  23. * There is a new type of character information file, the .stt file. The
  24. * name and location of this file is the same as for the n00?????.sts
  25. * file. The only difference is that it is written as a text file so it is
  26. * easier to read for you non-C programmers ... Read on
  27.  
  28. * If ya are too lazy to write a good installation program for your IGM then I 
  29. * included mine, it's easy to setup and use for almost any igm you make. Look
  30. * at it in the NY_IGMIN.ZIP file, which is included in the ny2008 main archive
  31. @ It now asks if the IGM should be added to 3rdparty.dat, 3rdevent.dat or both.
  32.  
  33.   Well ... so ya want to create something i haven't done already for NY2008
  34.   ...
  35.  
  36.   First a few tips on how i do stuff ... i LOVE binary files, whatever can be
  37.   IS in binary format ...
  38.  
  39.   And read the struct.doc for the structures of those files and a few extra
  40.   tips ...
  41.  
  42.   User number is the number in the user file...
  43.  
  44.   DO NOT CHANGE how many points the user has in the user file... you can do it
  45.   as an IGM and pass the new point value back to NY2008, but do not do it to 
  46.   users anytime otherwise. It will messup the score file for the day ...
  47.   (Actually in an IGM you can change almost all the user data, xpt the level,
  48.   and the rank variable, those will change when ny2008 reads in the .sts file)
  49.  
  50.   To get info on the user that's online read in his .sts file, changing this
  51.   will not effect anything unless you are returning from an igm so don't 
  52.   change it otherwise.
  53.  
  54.   DO NOT REARANGE USERS!!!!! (WILL MESS UP VERY VERY BAD!)
  55.   (or if ya have to read the struct.doc file VERY carefully, but i would not
  56.   recomend it ... and this is absolutely not to be done in IGM's anywayz)
  57.  
  58.   Flags for users (flag files I mean) are named 
  59.  
  60.   U00<0 padded user number>.<flag name>
  61.  
  62.   And they are store in the FlagDirectory if it is specified in the .cfg file
  63.  
  64.   For example online flag for user 36 would look like "U0000036.ON"
  65.  
  66.  
  67.   The temporary character dropfile is named (it is stored in the game
  68.   directory not in the flag didrectory!)
  69.  
  70.   N<0 padded node number>.STS
  71.  
  72.   For example .STS file for node 6 would look like "N0000006.STS"
  73.  
  74.   NOTE: There is also a flagfile called U00?????.STS ... this is used for
  75.   data recovery and if you dump any data in here it will not be read unless
  76.   the crash recovery is run ...
  77.  
  78. ==============================================================================
  79. How to create In Game Modules for NY2008!
  80. ==============================================================================
  81.  
  82. | If You'd like to see how an IGM looks inside look at NY_JPSRC.ZIP which  
  83. | is the source code for the Jackpot IGM. It's in Turbo C++ and OpenDoors 5.00
  84.  
  85.   To create NY2008 IGM's you actually create something like a door, only
  86.   easier, because you anly have to deal with one type of dropfile and one
  87.   character information file. These will be created in the game directory, so
  88.   you will have to get that information from the user. (I'd recomend having
  89.   it passed on the command line rather than having it read from a cfg file.)
  90. * There are two character dropfiles you can choose from now on ... so it's
  91. * easier for non-C programmers.
  92.  
  93.   NY2008 will pass the node number, the user number and if the game is local
  94.   or not, through the command line, by adding '-N<node number> -U<user number>'
  95.   and optionally '-L' if the game is in local mode, to the command line when
  96.   calling the IGM. '-L' is passed every local game no matter if it was started
  97.   from command line or from a dropfile.
  98.  
  99. @ You have to create or edit '3rdparty.dat' and/or '3rdevent.dat' and put in
  100. > appearance to user first and the command line on the second line. Comments
  101. * are OK! (comment lines start with ';'!) -  there can be any number of IGM's!
  102. * As i said above i'd recommend passing the path to the dropfiles on the
  103.   command line!
  104.  
  105. @ '3rdparty.dat' file will add your IGM to the other stuff menu!
  106. @ '3rdevent.dat' file will add your IGM as a random fight event! 
  107.  
  108.   Example:
  109.     `@B`4ar
  110.     C:\NY2008\BAR.BAT C:\BBS\NY2008\
  111.  
  112.   And the BAR.BAT would look like:
  113.  
  114.     cd\bar
  115.     bar.exe %1 %2 %3 %4
  116.     cd\ny2008
  117.  
  118.   Don't worry about changing dirs back ... ny2008 will do that by itself.
  119. } But the IGM will be run with the game dir of ny2008 as the current dir!!!!
  120. } so in the batch file make sure you change to the igm's dir, or o that in
  121. } the IGM itself. Or use the '*' described next
  122.  
  123. > There is also a new feature if you want NY2008 to change to the IGM's dir
  124. > before it is run, you add '*' as the VERY FIRST character in the command
  125. > line!
  126.  
  127. > Example:
  128. >   `@B`4ar
  129. >   *C:\NY2008\BAR\BAR.EXE C:\BBS\NY2008\
  130.  
  131. > This will run BAR.EXE in it's own dir (c:\ny2008\bar) so you don't need to
  132. > write a bat file as in the example above!
  133.  
  134.  
  135.   THE FILES: 
  136. @ You have to read both, and they are in the game directory, not the flag 
  137. @ directory! You can choose the character info file, but you have to read the 
  138. @ text version and delete the binary version, so that ny2008 knows you read 
  139. @ the text version, or just read the binary version, you don't have to delete 
  140. @ the text version, ny2008 will read the binary version as default, only if it 
  141. @ doesn't find it will it read the text version!
  142.  
  143.   The character information file (N<node number>.STS) is a binary file with
  144.   the user structure dumped into it. (read struct.doc) (this is the one you
  145.   can change!) (e.g. N0000003.STS for node 3)
  146.  
  147. * User rank and days user has been inactive will not be read in after an IGM
  148. * so it wouldn't kill the user or destroy others if they get changed in
  149. * the IGM.
  150.  
  151. * There is also a text character information file available too. if you want to
  152. * use that you have to delete the N<node number>.STS so that ny2008 will read
  153. * this file instead. The name for this file is N<node number>.STT!
  154. * It has the same data order as the character info structure, here it is:
  155. *
  156. } Line 1:  The BBS name of the user !!!Will not be read in!!!
  157. * Line 2:  The name of the character
  158. * Line 3:  What the user says when he wins
  159. * Line 4:  What the user says when he looses
  160. * Line 5:  User rank !!! Will not be read in !!!
  161. * Line 6:  Days the user has been inactive !!! Will not be read in !!!
  162. * Line 7:  Attacking strenght of the user !!these will have a change only for!!
  163. * Line 8:  Defensive strenght             !!this level I recomend no change  !!
  164. * Line 9:  Condoms user has
  165. * Line 10: Days since the user last got laid
  166. * Line 11: The hits of drug that the user has
  167. * Line 12: If addicted how long the user has not used the drug
  168. * Line 13: User's hitpoints
  169. * Line 14: Maximum of the user's hitpoints
  170. * Line 15: User's points
  171. * Line 16: Money in hand
  172. * Line 17: Money in bank
  173. * Line 18: User level
  174. * Line 19: Fights the user has left today
  175. * Line 20: % of hunger
  176. * Line 21: Sex turns left today
  177. * Line 22: % of current std infection
  178. * Line 23: % of drug addiction
  179. * Line 24: % of how "high" the player is
  180. * Line 25: For how many more days the hotel is paid for
  181. * Line 26: How many days has the user has been